-
Notifications
You must be signed in to change notification settings - Fork 13
feat: added announcement robot #109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
📝 WalkthroughWalkthroughAdds a new GitHub Actions workflow that runs on pushes to Changes
Sequence Diagram(s)sequenceDiagram
autonumber
participant Dev as Developer
participant GH as GitHub Actions
participant Repo as Repository
participant Action as Mastodon Post Action
participant Masto as Mastodon
Dev->>Repo: Push to main (CHANGELOG.md changed, commit msg: "chore(main): release...")
GH-->>GH: workflow on push + path filter matches
alt Commit message contains release token
GH->>Repo: actions/checkout
GH->>Action: invoke snakemake/mastodon-release-post-action (inputs: token, attachment, templates)
Action-->>Action: extract version & release notes
Action->>Masto: POST announcement + attachment
Masto-->>Action: confirmation (post URL)
Action-->>GH: job completes (success)
else
GH-->>GH: workflow skipped (commit message condition not met)
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 actionlint (1.7.8).github/workflows/announce-release.yml28-28: property "extract-release-notes" is not defined in object type {} (expression) 🔇 Additional comments (1)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@johanneskoester please check the pr logo and logo path, whether it is to your liking. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
pr_logo/pr_logo.pngis excluded by!**/*.png
📒 Files selected for processing (1)
.github/workflows/announce-release.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.8)
.github/workflows/announce-release.yml
28-28: property "extract-release-notes" is not defined in object type {}
(expression)
|
@johanneskoester removed pr-image logo, sticking with established logo in transparent form. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/workflows/announce-release.yml (1)
22-22: Consider pinning the action to a stable version tag.Line 22 uses
snakemake/mastodon-release-post-action@main, which always pulls the latest code frommain. For reproducibility and stability, consider pinning to a specific version tag (e.g.,@v1) instead.- uses: snakemake/mastodon-release-post-action@main # == latest + uses: snakemake/mastodon-release-post-action@v1This ensures the workflow is not affected by unexpected changes in the action's
mainbranch.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
img/snakedeploy_transparent.pngis excluded by!**/*.png
📒 Files selected for processing (1)
.github/workflows/announce-release.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.8)
.github/workflows/announce-release.yml
28-28: property "extract-release-notes" is not defined in object type {}
(expression)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: testing
🔇 Additional comments (1)
.github/workflows/announce-release.yml (1)
31-31: I need to verify the complete list of variables supported by the action and how the GitHub Actions context variable is handled.Jinja2 template placeholders are supported by the action.
The snakemake/mastodon-release-post-action does support simple double-curly template placeholders, so the message template using
{{ version }},{{ issue_url }}, and{{ changelog }}will work correctly. GitHub Actions variables like${{ steps.extract-release-notes.outputs.release_notes }}are evaluated by GitHub before being passed to the action, so that syntax is appropriate for GitHub Actions workflows.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/announce-release.yml(1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.8)
.github/workflows/announce-release.yml
28-28: property "extract-release-notes" is not defined in object type {}
(expression)
🔇 Additional comments (2)
.github/workflows/announce-release.yml (2)
26-27: Confirm status of image parameter removal.Lines 26–27 pass
imageandimage-descriptioninputs tosnakemake/mastodon-release-post-action, which according to the past review does not support these parameters. The previous review comment was marked "done," but these lines remain.Please clarify:
- Were these meant to be removed per the past review?
- Has
snakemake/mastodon-release-post-actionbeen updated to support image uploads?- If not, these should be removed to avoid silent failures.
42-42: Line 42 actionlint warning is a false positive (already resolved).The static analysis tool flags the reference to
steps.extract-release-notes.outputs.release_notesas undefined. However, the previous review confirmed this pattern is safe: themastodon-release-post-actionPython script automatically extracts release notes from CHANGELOG.md, and the reference evaluates to an empty string harmlessly. This matches the working workflow in snakemake/snakemake. No change needed.
added the mastodon announcement bot to snakedeploy.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.